---

TiPullXmlHandle Class Reference

#include <tinyxml.h>

Collaboration diagram for TiPullXmlHandle:

[legend]List of all members.

Public Member Functions
	TiPullXmlHandle (TiPullXmlNode *node)
	Create a handle from any node (at any depth of the tree.) This can be a null pointer.
	TiPullXmlHandle (const TiPullXmlHandle &ref)
	Copy constructor.
TiPullXmlHandle	FirstChild () const
	Return a handle to the first child node.
TiPullXmlHandle	FirstChild (const char *value, TiPullXmlNode::NodeType nType) const
	Return a handle to the first child node with the given name.
TiPullXmlHandle	FirstChildElement () const
	Return a handle to the first child element.
TiPullXmlHandle	FirstChildElement (const char *value) const
	Return a handle to the first child element with the given name.
TiPullXmlHandle	Child (int index) const
TiPullXmlHandle	ChildElement (const char *value, int index) const
TiPullXmlHandle	ChildElement (int index) const
TiPullXmlNode *	Node () const
	Return the handle as a TiPullXmlNode. This may return null.
TiPullXmlElement *	Element () const
	Return the handle as a TiPullXmlElement. This may return null.
TiPullXmlText *	Text () const
	Return the handle as a TiPullXmlText. This may return null.
Private Attributes
TiPullXmlNode *	node

---

Detailed Description

A TiXmlHandle is a class that wraps a node pointer with null checks; this is an incredibly useful thing. Note that TiXmlHandle is not part of the TinyXml DOM structure. It is a separate utility class.

Take an example:

	<Document>
		<Element attributeA = "valueA">
			<Child attributeB = "value1" />
			<Child attributeB = "value2" />
		</Element>
	<Document>
	

Assuming you want the value of "attributeB" in the 2nd "Child" element, it's very easy to write a *lot* of code that looks like:

	TiXmlElement* root = document.FirstChildElement( "Document" );
	if ( root )
	{
		TiXmlElement* element = root->FirstChildElement( "Element" );
		if ( element )
		{
			TiXmlElement* child = element->FirstChildElement( "Child" );
			if ( child )
			{
				TiXmlElement* child2 = child->NextSiblingElement( "Child" );
				if ( child2 )
				{
					// Finally do something useful.
	

And that doesn't even cover "else" cases. TiXmlHandle addresses the verbosity of such code. A TiXmlHandle checks for null pointers so it is perfectly safe and correct to use:

	TiXmlHandle docHandle( &document );
	TiXmlElement* child2 = docHandle.FirstChild( "Document" ).FirstChild( "Element" ).Child( "Child", 1 ).Element();
	if ( child2 )
	{
		// do something useful
	

Which is MUCH more concise and useful.

It is also safe to copy handles - internally they are nothing more than node pointers.

	TiXmlHandle handleCopy = handle;
	

What they should not be used for is iteration:

	int i=0; 
	while ( true )
	{
		TiXmlElement* child = docHandle.FirstChild( "Document" ).FirstChild( "Element" ).Child( "Child", i ).Element();
		if ( !child )
			break;
		// do something
		++i;
	}
	

It seems reasonable, but it is in fact two embedded while loops. The Child method is a linear walk to find the element, so this code would iterate much more than it needs to. Instead, prefer:

	TiXmlElement* child = docHandle.FirstChild( "Document" ).FirstChild( "Element" ).FirstChild( "Child" ).Element();

	for( child; child; child=child->NextSiblingElement() )
	{
		// do something
	}
	

---

Constructor & Destructor Documentation

TiPullXmlHandle::TiPullXmlHandle (  TiPullXmlNode *    node )  [inline]

Create a handle from any node (at any depth of the tree.) This can be a null pointer.

TiPullXmlHandle::TiPullXmlHandle (  const TiPullXmlHandle &    ref )  [inline]

Copy constructor.

---

Member Function Documentation

TiPullXmlHandle TiPullXmlHandle::Child (  int    index )  const

Return a handle to the "index" child. The first child is 0, the second 1, etc.

TiPullXmlHandle TiPullXmlHandle::ChildElement (  int    index )  const

Return a handle to the "index" child element. The first child element is 0, the second 1, etc. Note that only TiPullXmlElements are indexed: other types are not counted.

TiPullXmlHandle TiPullXmlHandle::ChildElement (  const char *    value, int    index )  const

Return a handle to the "index" child element with the given name. The first child element is 0, the second 1, etc. Note that only TiPullXmlElements are indexed: other types are not counted.

TiPullXmlElement* TiPullXmlHandle::Element (    )  const [inline]

Return the handle as a TiPullXmlElement. This may return null.

TiPullXmlHandle TiPullXmlHandle::FirstChild (  const char *    value, TiPullXmlNode::NodeType    nType )  const

Return a handle to the first child node with the given name.

TiPullXmlHandle TiPullXmlHandle::FirstChild (    )  const

Return a handle to the first child node.

TiPullXmlHandle TiPullXmlHandle::FirstChildElement (  const char *    value )  const

Return a handle to the first child element with the given name.

TiPullXmlHandle TiPullXmlHandle::FirstChildElement (    )  const

Return a handle to the first child element.

TiPullXmlNode* TiPullXmlHandle::Node (    )  const [inline]

Return the handle as a TiPullXmlNode. This may return null.

TiPullXmlText* TiPullXmlHandle::Text (    )  const [inline]

Return the handle as a TiPullXmlText. This may return null.

---

Member Data Documentation

TiPullXmlNode* TiPullXmlHandle::node [private]

---

The documentation for this class was generated from the following files:

• pull/tinyxml.h
• pull/tinyxml.cpp

---